home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / AIncludes / AppleEvents.a < prev    next >
Encoding:
Text File  |  1996-05-01  |  20.1 KB  |  697 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        AppleEvents.a
  3. ;
  4. ;    Contains:    AppleEvent Package Interfaces.
  5. ;
  6. ;    Version:    Technology:    System 7.5
  7. ;                Release:    Universal Interfaces 3.0d3 on Copland DR1
  8. ;
  9. ;    Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10. ;
  11. ;    Bugs?:        If you find a problem with this file, send the file and version
  12. ;                information (from above) and the problem description to:
  13. ;
  14. ;                    Internet:    apple.bugs@applelink.apple.com
  15. ;                    AppleLink:    APPLE.BUGS
  16. ;
  17. ;
  18.     IF &TYPE('__APPLEEVENTS__') = 'UNDEFINED' THEN
  19. __APPLEEVENTS__ SET 1
  20.  
  21.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  22.     include 'Types.a'
  23.     ENDIF
  24.     IF FOR_SYSTEM7_AND_SYSTEM8_DEPRECATED THEN
  25.     IF ¬ FOR_PTR_BASED_AE THEN
  26.     IF &TYPE('__MEMORY__') = 'UNDEFINED' THEN
  27.     include 'Memory.a'
  28.     ENDIF
  29.     IF &TYPE('__MIXEDMODE__') = 'UNDEFINED' THEN
  30.     include 'MixedMode.a'
  31.     ENDIF
  32.     IF &TYPE('__NOTIFICATION__') = 'UNDEFINED' THEN
  33.     include 'Notification.a'
  34.     ENDIF
  35.     IF &TYPE('__EVENTS__') = 'UNDEFINED' THEN
  36.     include 'Events.a'
  37.     ENDIF
  38.     ENDIF
  39.     ENDIF
  40.     IF FOR_SYSTEM8_PREEMPTIVE THEN
  41.     IF &TYPE('__KERNEL__') = 'UNDEFINED' THEN
  42.     include 'Kernel.a'
  43.     ENDIF
  44.     ENDIF
  45.     IF &TYPE('__AEDATAMODEL__') = 'UNDEFINED' THEN
  46.     include 'AEDataModel.a'
  47.     ENDIF
  48.  
  49.                                                             ; Keywords for Apple event parameters 
  50. keyDirectObject                    EQU        '----'
  51. keyErrorNumber                    EQU        'errn'
  52. keyErrorString                    EQU        'errs'
  53. keyProcessSerialNumber            EQU        'psn '                ; Keywords for special handlers 
  54. keyPreDispatch                    EQU        'phac'                ; preHandler accessor call 
  55. keySelectProc                    EQU        'selh'                ; more selector call 
  56.                                                             ; Keyword for recording 
  57. keyAERecorderCount                EQU        'recr'                ; available only in vers 1.0.1 and greater 
  58.                                                             ; Keyword for version information 
  59. keyAEVersion                    EQU        'vers'                ; available only in vers 1.0.1 and greater 
  60. ;  Event Class 
  61.  
  62. kCoreEventClass                    EQU        'aevt'
  63. ;  Event ID’s 
  64.  
  65. kAEOpenApplication                EQU        'oapp'
  66. kAEOpenDocuments                EQU        'odoc'
  67. kAEPrintDocuments                EQU        'pdoc'
  68. kAEQuitApplication                EQU        'quit'
  69. kAEAnswer                        EQU        'ansr'
  70. kAEApplicationDied                EQU        'obit'
  71. ;  Constants for recording 
  72.  
  73. kAEStartRecording                EQU        'reca'                ; available only in vers 1.0.1 and greater 
  74. kAEStopRecording                EQU        'recc'                ; available only in vers 1.0.1 and greater 
  75. kAENotifyStartRecording            EQU        'rec1'                ; available only in vers 1.0.1 and greater 
  76. kAENotifyStopRecording            EQU        'rec0'                ; available only in vers 1.0.1 and greater 
  77. kAENotifyRecording                EQU        'recr'                ; available only in vers 1.0.1 and greater 
  78.     IF FOR_SYSTEM8_PREEMPTIVE THEN
  79.     IF FOR_PTR_BASED_AE THEN
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88. ;  this will be removed by D11E3 or earlier (!!!)
  89. ; typedef AEHandlerTableRef             AEHandlerTable
  90.  
  91. ; typedef OptionBits                     AEReceiveMode
  92.  
  93.  
  94. kAEReceiveForever                EQU        $00000000
  95. kAEReceiveOneEvent                EQU        $00000001
  96. kAEReceiveUntilUnhandledEvent    EQU        $00000002
  97.     ENDIF
  98.     ENDIF
  99. ;  parameter to AESend 
  100. ; typedef OptionBits                     AESendOptions
  101.  
  102.  
  103. kAENeverInteract                EQU        $00000010            ; server should not interact with user 
  104. kAECanInteract                    EQU        $00000020            ; server may try to interact with user 
  105. kAEAlwaysInteract                EQU        $00000030            ; server should always interact with user where appropriate 
  106. kAECanSwitchLayer                EQU        $00000040            ; interaction may switch layer 
  107. kAEDontRecord                    EQU        $00001000            ; don't record this event - available only in vers 1.0.1 and greater 
  108. kAEDontExecute                    EQU        $00002000            ; don't send the event for recording - available only in vers 1.0.1 and greater 
  109. kAEProcessNonReplyEvents        EQU        $00008000            ; allow processing of non-reply events while awaiting synchronous AppleEvent reply 
  110.     IF FOR_SYSTEM7_AND_SYSTEM8_DEPRECATED THEN
  111.     IF ¬ FOR_PTR_BASED_AE THEN
  112. ; typedef SInt32                         AESendMode
  113.  
  114.  
  115. kAENoReply                        EQU        $00000001            ; sender doesn't want a reply to event 
  116. kAEQueueReply                    EQU        $00000002            ; sender wants a reply but won't wait 
  117. kAEWaitReply                    EQU        $00000003            ; sender wants a reply and will wait 
  118. kAEDontReconnect                EQU        $00000080            ; don't reconnect if there is a sessClosedErr from PPCToolbox 
  119. kAEWantReceipt                    EQU        $00000200            ; (nReturnReceipt) sender wants a receipt of message 
  120.     ENDIF
  121.     ENDIF
  122. ;  Constants for timeout durations 
  123.  
  124. kAEDefaultTimeout                EQU        -1                    ; timeout value determined by AEM 
  125. kNoTimeOut                        EQU        -2                    ; wait until reply comes back, however long it takes 
  126. ;  priority param of AESend 
  127. ; typedef SInt16                         AESendPriority
  128.  
  129.  
  130. kAENormalPriority                EQU        $00000000            ; post message at the end of the event queue 
  131. kAEHighPriority                    EQU        $00000001            ; post message at the front of the event queue (same as nAttnMsg) 
  132. ; typedef SInt8                         AEEventSource
  133.  
  134.  
  135. kAEUnknownSource                EQU        0
  136. kAEDirectCall                    EQU        1
  137. kAESameProcess                    EQU        2
  138. kAELocalProcess                    EQU        3
  139. kAERemoteProcess                EQU        4
  140.     IF FOR_SYSTEM7_AND_SYSTEM8_DEPRECATED THEN
  141.     IF ¬ FOR_PTR_BASED_AE THEN
  142.     ENDIF
  143.     ENDIF
  144.     IF FOR_SYSTEM8_PREEMPTIVE THEN
  145.     IF FOR_PTR_BASED_AE THEN
  146.     ENDIF
  147.     ENDIF
  148.     IF FOR_SYSTEM7_AND_SYSTEM8_DEPRECATED THEN
  149.     IF ¬ FOR_PTR_BASED_AE THEN
  150. ;
  151. ;*************************************************************************
  152. ;  The next couple of calls are basic routines used to create, send,
  153. ;  and process AppleEvents. 
  154. ;*************************************************************************
  155. ;
  156. ;
  157. ; pascal OSErr AESend(const AppleEvent *theAppleEvent, AppleEvent *reply, AESendMode sendMode, AESendPriority sendPriority, long timeOutInTicks, AEIdleUPP idleProc, AEFilterUPP filterProc)
  158. ;
  159.     IF ¬ GENERATINGCFM THEN
  160.         Macro
  161.         _AESend
  162.             move.w              #$0D17,D0
  163.             dc.w                $A816
  164.         EndM
  165.     ELSE
  166.         IMPORT_CFM_FUNCTION AESend
  167.     ENDIF
  168.  
  169. ;
  170. ; pascal OSErr AEProcessAppleEvent(const EventRecord *theEventRecord)
  171. ;
  172.     IF ¬ GENERATINGCFM THEN
  173.         Macro
  174.         _AEProcessAppleEvent
  175.             move.w              #$021B,D0
  176.             dc.w                $A816
  177.         EndM
  178.     ELSE
  179.         IMPORT_CFM_FUNCTION AEProcessAppleEvent
  180.     ENDIF
  181.  
  182.     ENDIF
  183.     ENDIF
  184.     IF FOR_SYSTEM8_PREEMPTIVE THEN
  185.     IF FOR_PTR_BASED_AE THEN
  186. ;
  187. ;*************************************************************************
  188. ;  The next set of calls are basic routines used to send and process AppleEvents. 
  189. ;*************************************************************************
  190. ;
  191. ;
  192. ; the reply param MUST be created by the caller if a reply is requested
  193. ; otherwise, the caller must specify nil, or a NULL AppleEvent, if no reply is requested
  194. ;
  195. ;
  196. ; extern OSStatus AESendEvent(const AppleEvent *theAppleEvent, AppleEvent *reply, AESendOptions sendOpts, AESendPriority sendPriority, Duration timeoutDuration)
  197. ;
  198.     IF GENERATINGCFM THEN
  199.         IMPORT_CFM_FUNCTION AESendEvent
  200.     ENDIF
  201.  
  202. ;
  203. ; extern OSStatus AESendEventQueueReply(const AppleEvent *theAppleEvent, const AEAddressDesc *replyAddress, AESendOptions sendOpts, AESendPriority sendPriority)
  204. ;
  205.     IF GENERATINGCFM THEN
  206.         IMPORT_CFM_FUNCTION AESendEventQueueReply
  207.     ENDIF
  208.  
  209. ;
  210. ; the reply param MUST be created by the caller if a reply is requested
  211. ; otherwise, the caller must specify nil, or a NULL AppleEvent, if no reply is requested
  212. ;
  213. ;
  214. ; extern OSStatus AESendEventToSelf(const AppleEvent *theAppleEvent, AppleEvent *reply, AEDispatcherRef whichDispatcher, AESendOptions sendOpts)
  215. ;
  216.     IF GENERATINGCFM THEN
  217.         IMPORT_CFM_FUNCTION AESendEventToSelf
  218.     ENDIF
  219.  
  220. ;
  221. ; extern OSStatus AESendDelayed(const AppleEvent *theAppleEvent, Duration delayForSend, AEDelayedSendRef *delayedSend)
  222. ;
  223.     IF GENERATINGCFM THEN
  224.         IMPORT_CFM_FUNCTION AESendDelayed
  225.     ENDIF
  226.  
  227. ;
  228. ; extern OSStatus AECancelDelayedSend(AEDelayedSendRef delayedSend)
  229. ;
  230.     IF GENERATINGCFM THEN
  231.         IMPORT_CFM_FUNCTION AECancelDelayedSend
  232.     ENDIF
  233.  
  234. ;
  235. ;*************************************************************************
  236. ;  The next couple of calls are for causing kernel asynchronous completion 
  237. ;  notifications to send an AppleEvent when they fire. 
  238. ;*************************************************************************
  239. ;
  240. ;
  241. ; extern OSStatus AECreateNotifier(const AppleEvent *theAppleEvent, KernelNotification *theNotification)
  242. ;
  243.     IF GENERATINGCFM THEN
  244.         IMPORT_CFM_FUNCTION AECreateNotifier
  245.     ENDIF
  246.  
  247. ;
  248. ; extern OSStatus AEDisposeNotifier(const KernelNotification *theNotification)
  249. ;
  250.     IF GENERATINGCFM THEN
  251.         IMPORT_CFM_FUNCTION AEDisposeNotifier
  252.     ENDIF
  253.  
  254.     ENDIF
  255.     ENDIF
  256. ;
  257. ; Note: during event processing, an event handler may realize that it is likely
  258. ; to exceed the client's timeout limit. Passing the reply to this
  259. ; routine causes a wait event to be generated that asks the client
  260. ; for more time. 
  261. ;
  262.     IF FOR_SYSTEM7_AND_SYSTEM8_PREEMPTIVE THEN
  263. ;
  264. ; pascal OSErr AEResetTimer(const AppleEvent *reply)
  265. ;
  266.     IF ¬ GENERATINGCFM THEN
  267.         Macro
  268.         _AEResetTimer
  269.             move.w              #$0219,D0
  270.             dc.w                $A816
  271.         EndM
  272.     ELSE
  273.         IMPORT_CFM_FUNCTION AEResetTimer
  274.     ENDIF
  275.  
  276.     ENDIF
  277. ;
  278. ;*************************************************************************
  279. ;  The following three calls are used to allow applications to behave
  280. ;  courteously when a user interaction such as a dialog box is needed. 
  281. ;*************************************************************************
  282. ;
  283.     IF FOR_SYSTEM7_AND_SYSTEM8_COOPERATIVE THEN
  284. ; typedef SInt8                         AEInteractAllowed
  285.  
  286.  
  287. kAEInteractWithSelf                EQU        0
  288. kAEInteractWithLocal            EQU        1
  289. kAEInteractWithAll                EQU        2
  290. ;
  291. ; pascal OSErr AEGetInteractionAllowed(AEInteractAllowed *level)
  292. ;
  293.     IF ¬ GENERATINGCFM THEN
  294.         Macro
  295.         _AEGetInteractionAllowed
  296.             move.w              #$021D,D0
  297.             dc.w                $A816
  298.         EndM
  299.     ELSE
  300.         IMPORT_CFM_FUNCTION AEGetInteractionAllowed
  301.     ENDIF
  302.  
  303. ;
  304. ; pascal OSErr AESetInteractionAllowed(AEInteractAllowed level)
  305. ;
  306.     IF ¬ GENERATINGCFM THEN
  307.         Macro
  308.         _AESetInteractionAllowed
  309.             move.w              #$011E,D0
  310.             dc.w                $A816
  311.         EndM
  312.     ELSE
  313.         IMPORT_CFM_FUNCTION AESetInteractionAllowed
  314.     ENDIF
  315.  
  316.     ENDIF
  317.     IF FOR_SYSTEM7_AND_SYSTEM8_DEPRECATED THEN
  318.     IF ¬ FOR_PTR_BASED_AE THEN
  319. ;
  320. ; pascal OSErr AEInteractWithUser(long timeOutInTicks, NMRecPtr nmReqPtr, AEIdleUPP idleProc)
  321. ;
  322.     IF ¬ GENERATINGCFM THEN
  323.         Macro
  324.         _AEInteractWithUser
  325.             move.w              #$061C,D0
  326.             dc.w                $A816
  327.         EndM
  328.     ELSE
  329.         IMPORT_CFM_FUNCTION AEInteractWithUser
  330.     ENDIF
  331.  
  332.     ENDIF
  333.     ENDIF
  334.     IF FOR_SYSTEM8_PREEMPTIVE THEN
  335.     IF FOR_PTR_BASED_AE THEN
  336. ;
  337. ;*************************************************************************
  338. ;  These calls are used to create and dispose Apple event handler tables,
  339. ;  as well as to install, get and remove handlers from them.
  340. ;*************************************************************************
  341. ;
  342. ;
  343. ; extern OSStatus AENewHandlerTable(AEHandlerTableRef *newTable, void *refCon)
  344. ;
  345.     IF GENERATINGCFM THEN
  346.         IMPORT_CFM_FUNCTION AENewHandlerTable
  347.     ENDIF
  348.  
  349. ;
  350. ; extern OSStatus AENewFilterHandlerTable(AEHandlerTableRef *newTable, void *refCon)
  351. ;
  352.     IF GENERATINGCFM THEN
  353.         IMPORT_CFM_FUNCTION AENewFilterHandlerTable
  354.     ENDIF
  355.  
  356. ;
  357. ; extern OSStatus AEShareHandlerTable(AEHandlerTableRef table, void *newRefcon, AEHandlerTableRef *newSharedReference)
  358. ;
  359.     IF GENERATINGCFM THEN
  360.         IMPORT_CFM_FUNCTION AEShareHandlerTable
  361.     ENDIF
  362.  
  363. ;
  364. ; extern OSStatus AEDisposeHandlerTable(AEHandlerTableRef table)
  365. ;
  366.     IF GENERATINGCFM THEN
  367.         IMPORT_CFM_FUNCTION AEDisposeHandlerTable
  368.     ENDIF
  369.  
  370. ;
  371. ; extern OSStatus AEGetHandlerTableRefCon(AEHandlerTableRef table, void **refCon)
  372. ;
  373.     IF GENERATINGCFM THEN
  374.         IMPORT_CFM_FUNCTION AEGetHandlerTableRefCon
  375.     ENDIF
  376.  
  377. ;
  378. ; extern OSStatus AEInstallHandler(AEHandlerTableRef table, AEEventClass handlerClass, AEEventID handlerID, AEEventHandlerProc handler, void *handlerRefcon)
  379. ;
  380.     IF GENERATINGCFM THEN
  381.         IMPORT_CFM_FUNCTION AEInstallHandler
  382.     ENDIF
  383.  
  384. ;
  385. ; extern OSStatus AERemoveHandler(AEHandlerTableRef table, AEEventClass handlerClass, AEEventID handlerID, AEEventHandlerProc handler)
  386. ;
  387.     IF GENERATINGCFM THEN
  388.         IMPORT_CFM_FUNCTION AERemoveHandler
  389.     ENDIF
  390.  
  391. ;
  392. ; extern OSStatus AEGetHandler(AEHandlerTableRef table, AEEventClass handlerClass, AEEventID handlerID, AEEventHandlerProc *handler, void **handlerRefcon)
  393. ;
  394.     IF GENERATINGCFM THEN
  395.         IMPORT_CFM_FUNCTION AEGetHandler
  396.     ENDIF
  397.  
  398. ;
  399. ;*************************************************************************
  400. ;  These calls are used to setup and get events from Apple event dispatchers.
  401. ;*************************************************************************
  402. ;
  403. ;
  404. ; extern AEDispatcherRef AEGetDefaultDispatcher(void )
  405. ;
  406.     IF GENERATINGCFM THEN
  407.         IMPORT_CFM_FUNCTION AEGetDefaultDispatcher
  408.     ENDIF
  409.  
  410. ;
  411. ; extern OSStatus AECreateEventDispatcher(AEDispatcherRef *newDispatcher, MemAllocatorRef allocator)
  412. ;
  413.     IF GENERATINGCFM THEN
  414.         IMPORT_CFM_FUNCTION AECreateEventDispatcher
  415.     ENDIF
  416.  
  417. ;
  418. ; extern OSStatus AEDisposeEventDispatcher(AEDispatcherRef deadDispatcher)
  419. ;
  420.     IF GENERATINGCFM THEN
  421.         IMPORT_CFM_FUNCTION AEDisposeEventDispatcher
  422.     ENDIF
  423.  
  424. ;
  425. ; extern OSStatus AEGetEventDispatcherID(AEDispatcherRef dispatcher, AEDispatcherID *globalIdentity)
  426. ;
  427.     IF GENERATINGCFM THEN
  428.         IMPORT_CFM_FUNCTION AEGetEventDispatcherID
  429.     ENDIF
  430.  
  431. ;
  432. ; extern OSStatus AEPushDispatcherHandlerTable(AEDispatcherRef dispatcher, AEHandlerTableRef table)
  433. ;
  434.     IF GENERATINGCFM THEN
  435.         IMPORT_CFM_FUNCTION AEPushDispatcherHandlerTable
  436.     ENDIF
  437.  
  438. ;
  439. ; extern OSStatus AEPopDispatcherHandlerTable(AEDispatcherRef dispatcher, AEHandlerTableRef *table)
  440. ;
  441.     IF GENERATINGCFM THEN
  442.         IMPORT_CFM_FUNCTION AEPopDispatcherHandlerTable
  443.     ENDIF
  444.  
  445. ;
  446. ; extern OSStatus AEGetDispatcherTopHandlerTable(AEDispatcherRef dispatcher, AEHandlerTableRef *table)
  447. ;
  448.     IF GENERATINGCFM THEN
  449.         IMPORT_CFM_FUNCTION AEGetDispatcherTopHandlerTable
  450.     ENDIF
  451.  
  452. ;
  453. ; extern OSStatus AEReceive(AEDispatcherRef waitDispatcher, AEReceiveMode receiveMode)
  454. ;
  455.     IF GENERATINGCFM THEN
  456.         IMPORT_CFM_FUNCTION AEReceive
  457.     ENDIF
  458.  
  459.     ENDIF
  460.     ENDIF
  461.     IF FOR_SYSTEM7_AND_SYSTEM8_DEPRECATED THEN
  462.     IF ¬ FOR_PTR_BASED_AE THEN
  463. ;
  464. ;*************************************************************************
  465. ;  These calls are used to set up and modify the event dispatch table.
  466. ;*************************************************************************
  467. ;
  468. ;
  469. ; pascal OSErr AEInstallEventHandler(AEEventClass theAEEventClass, AEEventID theAEEventID, AEEventHandlerUPP handler, long handlerRefcon, Boolean isSysHandler)
  470. ;
  471.     IF ¬ GENERATINGCFM THEN
  472.         Macro
  473.         _AEInstallEventHandler
  474.             move.w              #$091F,D0
  475.             dc.w                $A816
  476.         EndM
  477.     ELSE
  478.         IMPORT_CFM_FUNCTION AEInstallEventHandler
  479.     ENDIF
  480.  
  481. ;
  482. ; pascal OSErr AERemoveEventHandler(AEEventClass theAEEventClass, AEEventID theAEEventID, AEEventHandlerUPP handler, Boolean isSysHandler)
  483. ;
  484.     IF ¬ GENERATINGCFM THEN
  485.         Macro
  486.         _AERemoveEventHandler
  487.             move.w              #$0720,D0
  488.             dc.w                $A816
  489.         EndM
  490.     ELSE
  491.         IMPORT_CFM_FUNCTION AERemoveEventHandler
  492.     ENDIF
  493.  
  494. ;
  495. ; pascal OSErr AEGetEventHandler(AEEventClass theAEEventClass, AEEventID theAEEventID, AEEventHandlerUPP *handler, long *handlerRefcon, Boolean isSysHandler)
  496. ;
  497.     IF ¬ GENERATINGCFM THEN
  498.         Macro
  499.         _AEGetEventHandler
  500.             move.w              #$0921,D0
  501.             dc.w                $A816
  502.         EndM
  503.     ELSE
  504.         IMPORT_CFM_FUNCTION AEGetEventHandler
  505.     ENDIF
  506.  
  507. ;
  508. ;*************************************************************************
  509. ; The following four calls are available for applications which need more
  510. ; sophisticated control over when and how events are processed. Applications
  511. ; which implement multi-session servers or which implement their own
  512. ; internal event queueing will probably be the major clients of these
  513. ; routines. They can be called from within a handler to prevent the AEM from
  514. ; disposing of the AppleEvent when the handler returns. They can be used to
  515. ; asynchronously process the event (as MacApp does).
  516. ;*************************************************************************
  517. ;
  518. ;
  519. ; pascal OSErr AESuspendTheCurrentEvent(const AppleEvent *theAppleEvent)
  520. ;
  521.     IF ¬ GENERATINGCFM THEN
  522.         Macro
  523.         _AESuspendTheCurrentEvent
  524.             move.w              #$022B,D0
  525.             dc.w                $A816
  526.         EndM
  527.     ELSE
  528.         IMPORT_CFM_FUNCTION AESuspendTheCurrentEvent
  529.     ENDIF
  530.  
  531. ;
  532. ; Note: The following routine tells the AppleEvent manager that processing
  533. ; is either about to resume or has been completed on a previously suspended
  534. ; event. The procPtr passed in as the dispatcher parameter will be called to
  535. ; attempt to redispatch the event. Several constants for the dispatcher
  536. ; parameter allow special behavior. They are:
  537. ;      - kAEUseStandardDispatch means redispatch as if the event was just
  538. ;      received, using the standard AppleEvent dispatch mechanism.
  539. ;      - kAENoDispatch means ignore the parameter.
  540. ;         Use this in the case where the event has been handled and no
  541. ;      redispatch is needed.
  542. ;      - non nil means call the routine which the dispatcher points to.
  543. ;
  544. ;  Constants for Refcon in AEResumeTheCurrentEvent with kAEUseStandardDispatch 
  545.  
  546. kAEDoNotIgnoreHandler            EQU        $00000000
  547. kAEIgnoreAppPhacHandler            EQU        $00000001            ; available only in vers 1.0.1 and greater 
  548. kAEIgnoreAppEventHandler        EQU        $00000002            ; available only in vers 1.0.1 and greater 
  549. kAEIgnoreSysPhacHandler            EQU        $00000004            ; available only in vers 1.0.1 and greater 
  550. kAEIgnoreSysEventHandler        EQU        $00000008            ; available only in vers 1.0.1 and greater 
  551. kAEIngoreBuiltInEventHandler    EQU        $00000010            ; available only in vers 1.0.1 and greater 
  552. kAEDontDisposeOnResume            EQU        $80000000            ; available only in vers 1.0.1 and greater 
  553. ;  Constants for AEResumeTheCurrentEvent 
  554.  
  555. kAENoDispatch                    EQU        0                    ; dispatch parameter to AEResumeTheCurrentEvent takes a pointer to a dispatch 
  556. kAEUseStandardDispatch            EQU        $FFFFFFFF            ; table, or one of these two constants 
  557. ;
  558. ; pascal OSErr AEResumeTheCurrentEvent(const AppleEvent *theAppleEvent, const AppleEvent *reply, AEEventHandlerUPP dispatcher, long handlerRefcon)
  559. ;
  560.     IF ¬ GENERATINGCFM THEN
  561.         Macro
  562.         _AEResumeTheCurrentEvent
  563.             move.w              #$0818,D0
  564.             dc.w                $A816
  565.         EndM
  566.     ELSE
  567.         IMPORT_CFM_FUNCTION AEResumeTheCurrentEvent
  568.     ENDIF
  569.  
  570. ;
  571. ; pascal OSErr AEGetTheCurrentEvent(AppleEvent *theAppleEvent)
  572. ;
  573.     IF ¬ GENERATINGCFM THEN
  574.         Macro
  575.         _AEGetTheCurrentEvent
  576.             move.w              #$021A,D0
  577.             dc.w                $A816
  578.         EndM
  579.     ELSE
  580.         IMPORT_CFM_FUNCTION AEGetTheCurrentEvent
  581.     ENDIF
  582.  
  583. ;
  584. ; pascal OSErr AESetTheCurrentEvent(const AppleEvent *theAppleEvent)
  585. ;
  586.     IF ¬ GENERATINGCFM THEN
  587.         Macro
  588.         _AESetTheCurrentEvent
  589.             move.w              #$022C,D0
  590.             dc.w                $A816
  591.         EndM
  592.     ELSE
  593.         IMPORT_CFM_FUNCTION AESetTheCurrentEvent
  594.     ENDIF
  595.  
  596.     ENDIF
  597.     ENDIF
  598. ;
  599. ;*************************************************************************
  600. ;  These calls are used to set up and modify special hooks into the
  601. ;  AppleEvent manager.
  602. ;*************************************************************************
  603. ;
  604.     IF FOR_SYSTEM7_AND_SYSTEM8_DEPRECATED THEN
  605.     IF ¬ FOR_PTR_BASED_AE THEN
  606. ;
  607. ; pascal OSErr AEInstallSpecialHandler(AEKeyword functionClass, UniversalProcPtr handler, Boolean isSysHandler)
  608. ;
  609.     IF ¬ GENERATINGCFM THEN
  610.         Macro
  611.         _AEInstallSpecialHandler
  612.             move.w              #$0500,D0
  613.             dc.w                $A816
  614.         EndM
  615.     ELSE
  616.         IMPORT_CFM_FUNCTION AEInstallSpecialHandler
  617.     ENDIF
  618.  
  619. ;
  620. ; pascal OSErr AERemoveSpecialHandler(AEKeyword functionClass, UniversalProcPtr handler, Boolean isSysHandler)
  621. ;
  622.     IF ¬ GENERATINGCFM THEN
  623.         Macro
  624.         _AERemoveSpecialHandler
  625.             move.w              #$0501,D0
  626.             dc.w                $A816
  627.         EndM
  628.     ELSE
  629.         IMPORT_CFM_FUNCTION AERemoveSpecialHandler
  630.     ENDIF
  631.  
  632. ;
  633. ; pascal OSErr AEGetSpecialHandler(AEKeyword functionClass, UniversalProcPtr *handler, Boolean isSysHandler)
  634. ;
  635.     IF ¬ GENERATINGCFM THEN
  636.         Macro
  637.         _AEGetSpecialHandler
  638.             move.w              #$052D,D0
  639.             dc.w                $A816
  640.         EndM
  641.     ELSE
  642.         IMPORT_CFM_FUNCTION AEGetSpecialHandler
  643.     ENDIF
  644.  
  645.     ENDIF
  646.     ENDIF
  647.     IF FOR_SYSTEM8_PREEMPTIVE THEN
  648.     IF FOR_PTR_BASED_AE THEN
  649. ;
  650. ; extern OSStatus AEInstallSpecialCallback(AEDispatcherRef dispatcher, AEKeyword functionClass, ProcPtr handler)
  651. ;
  652.     IF GENERATINGCFM THEN
  653.         IMPORT_CFM_FUNCTION AEInstallSpecialCallback
  654.     ENDIF
  655.  
  656. ;
  657. ; extern OSStatus AERemoveSpecialCallback(AEDispatcherRef dispatcher, AEKeyword functionClass, ProcPtr handler)
  658. ;
  659.     IF GENERATINGCFM THEN
  660.         IMPORT_CFM_FUNCTION AERemoveSpecialCallback
  661.     ENDIF
  662.  
  663. ;
  664. ; extern OSStatus AEGetSpecialCallback(AEDispatcherRef dispatcher, AEKeyword functionClass, ProcPtr *handler)
  665. ;
  666.     IF GENERATINGCFM THEN
  667.         IMPORT_CFM_FUNCTION AEGetSpecialCallback
  668.     ENDIF
  669.  
  670.     ENDIF
  671.     ENDIF
  672. ;
  673. ;*************************************************************************
  674. ;  This call was added in version 1.0.1. If called with the keyword
  675. ;  keyAERecorderCount ('recr'), the number of recorders that are
  676. ;  currently active is returned in 'result'
  677. ;  (available only in vers 1.0.1 and greater).
  678. ;*************************************************************************
  679. ;
  680.     IF FOR_SYSTEM7_AND_SYSTEM8_PREEMPTIVE THEN
  681. ;
  682. ; pascal OSErr AEManagerInfo(AEKeyword keyWord, long *result)
  683. ;
  684.     IF ¬ GENERATINGCFM THEN
  685.         Macro
  686.         _AEManagerInfo
  687.             move.w              #$0441,D0
  688.             dc.w                $A816
  689.         EndM
  690.     ELSE
  691.         IMPORT_CFM_FUNCTION AEManagerInfo
  692.     ENDIF
  693.  
  694.     ENDIF
  695.     ENDIF ; __APPLEEVENTS__ 
  696.  
  697.